/* Gauge - Performance Measurement Framework for Mobile Platforms
 * Copyright (C) 2013, Juha Hytonen <juha.a.hytonen@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.gauge;

import java.io.File;

import org.gauge.Log;

/**
 * The base class for all file based benchmark execution logs.
 * 
 * AbstractFileLog uses FileManager to manage the log file and
 * provides convenience methods for writing log entries into it.
 * 
 * Override writeEntry() in your implementation to handle log entries.
 * 
 * @see FileManager
 * @see Log
 */
public abstract class AbstractFileLog extends Log {

	private FileManager fileManager;

	public AbstractFileLog(File file) throws Exception {
		fileManager = new FileManager(file);
	}

	@Override
	protected final void close() {
		try {
			fileManager.Close();
		}
		catch(Exception e) {
			// Ignore exceptions for logging.
		}
	}

	@Override
	protected final void addEntry(LogEntry entry) {
		try {
			writeEntry(entry);
		}
		catch(Exception e) {
			// Ignore exceptions for logging.
		}
	}
	
	/**
	 * In your class you should create lines from log entries and use
	 * writeLine() and write() to write them into the log file.
	 */
	protected abstract void writeEntry(LogEntry entry) throws Exception;

	/**
	 * Writes given line into the log file. Line break is automatically appended.
	 */
	protected final void writeLine(String line) throws Exception {
		fileManager.WriteLine(line);
	}

	/**
	 * Writes given data into the log file. No line break is appended.
	 */
	protected final void write(String data) throws Exception {
		fileManager.Write(data);
	}

}
